home *** CD-ROM | disk | FTP | other *** search
- DWDoor Functions and Subroutines Quick Reference
- ------------------------------------------------
-
- Procedure Name Typ Description
- -------------- --- -----------
- Ansi% VAR -1 if ANSI allowed, 0 if not.
- AnsiColor$(Atr%) FUN Returns an ANSI command for changing colors
- AnsiLocate$(Row%,Col%) FUN Returns an ANSI command for locating the
- cursor
- Attr%(forg%, bak%) FUN Returns an integer attribute of foreground
- and background colors
- BBS$ VAR The BBS name.
- Back% VAR Current background color.
- Baud& VAR The baud rate of ComPort%.
- Beeper& VAR Milliseconds before beep for no input
- CLR SUB Clears the local and user screen
- CR$ VAR Carridge return CHR$(13)
- CRLF$ VAR Return + Linefeed CHR$(13)+CHR$(10)
- Carrier%(Comm%) FUN Tests to see if a carrier is present.
- Center$(Lin$,Columns%) FUN Returns a string centered in a string of
- spaces
- CheckTime SUB Checks the time in the program and exits if
- exceeded
- ComInit$ VAR Complete string for opening com port.
- ComParity% VAR The parity of ComPort%.
- ComPort% VAR The comport number (1-8).
- Comm% VAR OPENed COM port number.
- CommKey$ FUN Same as INKEY$ only checks the current
- opened com port as well as the keyboard for
- input. Also does time checking.
- DCSRLIN% FUN Gets the current cursor row position.
- DesqView aware.
- DPos% FUN Gets the current cursor col position.
- DesqView aware.
- DPrint(Text$) SUB Prints text on the screen at current cursor
- position.
- DVGivUp SUB Gives up a time slice of the active DesqView
- window.
- DVPrint(Row%,Col%,Text$,Atr%) SUB Prints text on the screen in active DesqView
- window.
- DataLen%(Comm%) FUN Gets the Data length of the current opened
- com port (1-8)
- DoorHelp$ VAR The filename displayed when ? used on the
- command line.
- DoorInfo$(Path$) FUN Gets user and comport information from the
- filename specified in Path$
- DoorInit(Path$) SUB Sets up variable defaults and constants as
- well as reads the .CFG file and gets
- information from it. If Path$="NONE" then
- it will not prompt for any info from the
- user, just gets all info from the door
- file, and from the .CFG
- DoorName$ VAR Full Name of door.
- ErrLevel% FUN Returns the ERRORLEVEL of a child process
- shell.
- ErrorFile$ VAR The filename to write errors to.
- Exist%(File$) FUN Tests to see if File$ exists in the path
- specified.
- ExitDoor(Typ%) SUB Closes all files and ends the program.
- Extra$ VAR Extra string of 70 characters or less (opt).
- False% VAR Constant 0
- FirstName$ VAR User's First Name.
- Fore% VAR Current foreground color.
- GetBaud&(Comm%) FUN Gets the baud rate of the current opened
- comport (1-8)
- GetExtra$(Search$) FUN Retrieves extra CFG variables
- GetLocalInfo SUB If in LOCAL mode, this routine will ask for
- questions and set up various defaults.
- Help(Fil$) SUB Loads help information contained in Fil$ if
- ? is used on the command line and asks if
- user would like to enter LOCAL mode. Also
- pauses every 23 lines while displaying.
- This file is not displayed to remote, only
- locally.
- InComm$(Atr%,Agln%,NoRet%, FUN Gets input from the keyboard or comport if
- Deflt$,DefHlt%, active.
- Choice$,Prompt$) Atr% = Color attribute to print prompt.
- Agln% = Length of input to accept.
- If 0 then word-wrapping enabled,
- input is displayed, no return
- required, CRLF is issued.
- If negative then input is not
- displayed when entered.
- If positive then input is
- displayed when entered.
- NoRet% = If 0 then a return is required to
- end input.
- If negative, No return
- is required.
- If positive, No return is
- required, a CRLF is issued.
- Deflt$ = Default for no input, or 1
- character for hidden text.
- InHlt% = Color attribute for displaying
- input.
- Choice$ = Allowed input, if blank then any
- legal ASCII character is
- accepted.
- Prompt$ = Prompt to print before getting
- input.
- InText$ VAR Extra input from the user
- IRQ$ VAR User's IRQ number (from 2 to 15) "" if not
- used.
- KBLocal% VAR -1 if LOCAL, 0 if at REMOTE.
- KBTime& VAR KB time-out limit in seconds.
- LBack$ VAR CHR$(29)
- LBackSp$ VAR Local Backspace
- LastName$ VAR User's Last Name.
- Line25 SUB Prints status on lines 24 and 25
- MaxTime& VAR Maximum amount of time in door allowed in
- secs.
- More% FUN Prompts for input from user if he wishes
- more information.
- Returns -1 if Yes
- 0 if No
- 1 if Continous
- NormalColor$ VAR Resets ANSI color to White on Black
- Okay% VAR -1 if serial code matches, 0 if not
- OutComm(Atr%,LineFeed%,Text$) SUB Prints a string out to the screen and
- comport if active.
- Atr% = color attribute
- LineFeed% = adds a linefeed if non-zero
- to string printed
- Text$ = String to print
- PAUSE SUB Prompts user to press a key to continue
- Parity%(Comm%) FUN Gets the parity of the opened com port (1-8)
- Parm$(Main$,Search$) FUN Parses string to any specified character(s)
- PrintFile(Tmp%,Fl$) SUB Prints an entire file to user with MORE
- prompting. If Tmp% is a non-zero number,
- then the screen is cleared before
- displaying the file.
- RBack$ VAR CHR$(8)
- RBackSp$ VAR Remote Backspace
- Script(Func$,InStr$,OutStr$) SUB Use any of the commands in this lib
- textually.
- Scrn2Str$(X1%,Y1%,X2%,Y2%) FUN Allows you to capture a portion of the
- screen in ANSI.
- Serial$ VAR Returned from SERIAL variable in .CFG
- StopBits%(Comm%) FUN Gets the Stop Bits of the current opened
- comport. (1-8)
- SysopF$ VAR The Sysop's First name.
- SysopL$ VAR The Sysop's Last name.
- SysopName$ VAR The full sysop's name (All Uppercase).
- TestComm SUB Tests to see if a carrier is present if
- door activated in remote mode. Writes to
- DWDOOR.ERR if carrier has been dropped.
- TimeIn& VAR Time user started program in seconds.
- TimeLeft& VAR Total time left in door in seconds.
- Trim$(T$) FUN Trims a string on both ends
- True% VAR Constant -1
- UserName$ VAR User's Full Name (All Uppercase).
- WriteDoorERR(TypERR%,Tmp$) SUB Creates a file called DWDOOR.ERR that will
- contain the error information and brief
- explaination of how to correct it.
-
